"""
文件名：urls.py
作者：教务系统开发团队
创建日期：2025-05-01
描述：API文档应用的URL配置

本文件配置了教务系统的API文档相关路由，包括：
1. OpenAPI 3.0 规范文件生成
2. Swagger UI 交互式文档界面
3. ReDoc 文档界面

使用drf-spectacular库自动生成API文档，支持以下功能：
- 自动从Django REST Framework视图生成API规范
- 支持参数验证和响应模型定义
- 提供交互式API测试界面
"""

from django.urls import path
from drf_spectacular.views import (
    SpectacularAPIView,
    SpectacularRedocView,
    SpectacularSwaggerView
)

urlpatterns = [
    # OpenAPI 3.0 规范文件生成
    path('schema/', SpectacularAPIView.as_view(), name='schema'),
    
    # Swagger UI 文档界面 - 适合开发人员使用
    path('swagger/', 
        SpectacularSwaggerView.as_view(
            url_name='schema',
            template_name='swagger-ui.html',
            title='教务系统API文档',
            description='教务系统REST API交互式文档，支持在线测试API接口'
        ), 
        name='swagger-ui'),
    
    # ReDoc 文档界面 - 适合非技术人员查看
    path('redoc/', 
        SpectacularRedocView.as_view(
            url_name='schema',
            title='教务系统API文档',
            description='教务系统REST API文档，包含所有接口的详细说明'
        ), 
        name='redoc'),
]